/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package com.softace.jdbc;

/**
 * The Connection Parameters interface. It contains method signatures that
 * contain necessary parameters to establish a connection to a database.<br>
 * Additionally this interface can be implemented to connect to any other
 * database.<br>This method is also implemented by
 * <code>JdbcConnectionParameters</code> class.
 *
 * @author S1LENT W@RRIOR
 * @version 1.0
 */
public interface IConnectionParameters {

    /**
     * Gives the Database Driver name. Implement this method to return your
     * database driver's name.<br>for example: In case of MySQL, it this method
     * should return:
     * <code>com.mysql.jdbc.Driver</code>
     *
     * @return The Database driver name
     */
    public String getDriverName();

    /**
     * Gives the Connection String. Implement this method to return your
     * database Connection String.<br>for example: In case of MySQL server
     * deployed at localhost at port 3306, this method should return:
     * <code>jdbc:mysql://localhost:3306/</code><br>Where localhost is the IP
     * address where mysql server is deployed and 3306 is the port MySQL server.
     *
     * @return The Connection String
     */
    public String getConnectionString();

    /**
     * Gives the name of the database, to which you want to connect on your
     * database server.
     *
     * @return The name of the database
     */
    public String getDatabaseName();

    /**
     * Gives the username used to authenticate the user on Database
     *
     * @return The username
     */
    public String getUsername();

    /**
     * Gives the password used to authenticate the user on Database. In case of
     * no password, implement this method to return an empty String or null
     *
     * @return The password
     */
    public String getPassword();
}